Event Object Attributes

When a rule is triggered, the function is provided the event instance that triggered it. The specific data depends on the event type. For example, the event object returned by the ItemStateChangedEvent event type has itemName, itemState, and oldItemState attributes. The StartupTrigger and GenericCronTrigger do not provide any event objects. Rather than digging through the code to look up the attributes available in a particular event object, you can add a log entry inside the function and then trigger the rule (View the names of an object’s attributes).

Here is a table of the attributes available in event objects (or inputs['event'], if using raw API or extensions), including a comparison to the Rules DSL implicit variables:

Rules DSL Equivalent	Scripted Automation	@when Trigger(s)	Event Object(s)	Description
triggeringItem.name	event.itemName	“received update” “changed” “received command”	ItemStateEvent ItemStateChangedEvent ItemCommandEvent ItemStatePredictedEvent GroupItemStateChangedEvent	Name of Item that triggered event (String)
triggeringItem.name	event.memberName	“changed”	GroupItemStateChangedEvent	Name of member that caused the state change of a parent Group (String)
triggeringItem.state	event.itemState	“received update” “changed”	ItemStateEvent ItemStateChangedEvent	State of item that triggered event (State)
previousState	event.oldItemState	“changed”	ItemStateChangedEvent GroupItemStateChangedEvent	Previous state of Item or Group that triggered event (State)
receivedCommand	event.itemCommand	“received command”	ItemCommandEvent	Command that triggered event (Command)
N/A	event.predictedState	Not currently supported	ItemStatePredictedEvent	State that the Item triggering the event is predicted to have (State)
N/A	event.isConfirmation	Not currently supported	ItemStatePredictedEvent	If true then it basically only confirms the previous item state because a received command will not be successfully executed and therefore presumably will not result in a state change (e.g. because no handler currently is capable of delivering such an event to its device) (Boolean)
N/A	event.newItemState	Not currently supported	GroupItemStateChangedEvent	State of Group that triggered event (State)
N/A	event.item	Not currently supported	ItemAddedEvent	Item that triggered event (Item)
N/A	event.oldItem	Not currently supported	ItemUpdatedEvent	Item DTO prior to the Item being updated (Item)
N/A	event.channel	“triggered”	ChannelTriggeredEvent	Channel associated with Event that triggered event (Channel)
N/A	event.event	“triggered”	ChannelTriggeredEvent	Event that triggered event (Event)
N/A	event.thing	Not currently supported	ThingAddedEvent	Thing that triggered event (Thing)
N/A	event.oldThing	Not currently supported	ThingUpdatedEvent	Thing DTO prior to the Thing being updated (Thing)
N/A	event.thingUID	“changed”	ThingStatusInfoEvent ThingStatusInfoChangedEvent	ThingUID of Thing that triggered event (ThingUID)
N/A	event.statusInfo	“changed”	ThingStatusInfoEvent ThingStatusInfoChangedEvent	ThingStatusInfo of Thing that triggered event (ThingStatusInfo)
N/A	event.oldStatusInfo	“changed”	ThingStatusInfoChangedEvent	Previous ThingStatusInfo of Thing that triggered event (ThingStatusInfo)